package se.janlindblom.ordning.typ.samling;

/**
 * $Id: Quarters.java 58 2009-12-06 16:38:19Z lindblom.jan $
 * 
 * Copyright (c) 2009, Jan Lindblom
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * * Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * 
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * 
 * * Neither the name of the project nor the names of its contributors may be
 *   used to endorse or promote products derived from this software without
 *   specific prior written permission.
 *   
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 */

import java.util.Stack;

import se.janlindblom.ordning.typ.Quarter;

/**
 * Quarters - collection of {@link Quarter}s.
 * 
 * @author Jan Lindblom (lindblom.jan@gmail.com)
 * @version $Rev: 58 $
 */
public class Quarters {
	private Stack<Quarter> quarters;
	private int capacity;
	private int size;
	
	/**
	 * Creates an empty Quarters object with room for 4 {@link Quarter}s.
	 */
	public Quarters() {
		quarters = new Stack<Quarter>();
		capacity = 4;
		size = 0;
	}
	
	/**
	 * Creates an empty Quarters object with the given capacity.
	 * 
	 * @param capacity capacity of this Quarters object
	 */
	public Quarters(int capacity) {
		quarters = new Stack<Quarter>();
		this.capacity = capacity;
		size = 0;
	}
	
	/**
	 * Pushes a {@link Quarter} to the stack.
	 * 
	 * @param quarter the {@link Quarter} to push
	 * @return the pushed {@link Quarter} or null if this stack is full
	 */
	public Quarter push(Quarter quarter) {
		if (this.capacity() > 0) {
			this.size++;
			this.capacity--;
			return quarters.push(quarter);
		}
		return null;
	}
	
	/**
	 * Pops a {@link Quarter} from the stack.
	 * 
	 * @return the popped {@link Quarter}
	 */
	public Quarter pop() {
		return quarters.pop();
	}
	
	/**
	 * Returns the capacity of this Quarters object.
	 * 
	 * @return the capacity of this Quarters object
	 */
	public int capacity() {
		return this.capacity;
	}
}
